home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / system / incdos20.zip / INCDOS.TXT < prev    next >
Text File  |  1995-02-20  |  10KB  |  203 lines
  1. -----------------------------------------------------------------------------
  2. INCDOS Release 2.0 Documentation
  3. -----------------------------------------------------------------------------
  4.  
  5. INCDOS is a set of programs that are used like standard DOS commands,
  6. designed to add functionality and ease-of-use to DOS systems, especially with
  7. regard to the management of complex directory structures.  The set currently
  8. includes:
  9.  
  10. BDIR ("Branch DIRectory")  v1.3 | Dir of filespec-matching files in branch
  11. BDEL ("Branch DELete")     v1.1 | Prompted delete of matching files in branch
  12. GD   ("Go to Directory")   v1.2 | Searches for and changes to matching subdir
  13. KD   ("Kill Directory")    v1.3 | Removes entire specified subdir branch
  14. XD ("eXpand to Directory") v1.1 | Creates like-named subdirs for files, moves
  15. MP   ("Make Path")         v1.0 | Creates nested set of directories
  16. CLEAR                      v1.0 | Irretrievably erases files
  17. SIZE                       v1.1 | Shows overview of disk usage of branches
  18.  
  19. These programs should be placed in a subdirectory included in the DOS path,
  20. such as the DOS subdirectory itself.  Executing any of them without
  21. parameters gives basic documentation.
  22.  
  23. INCDOS commands are designed to complement each other, so they are best used
  24. as a set.  For example, the location of a file can be quickly found with BDIR,
  25. and gone directly to with GD.  INCDOS commands execute especially fast with
  26. Microsoft's SMARTDRV installed.  They can be executed from batch files, and
  27. their output can be redirected and piped.
  28.  
  29. -----------------------------------------------------------------------------
  30.  
  31. BDIR.COM ("Branch DIRectory") gives a directory of all files within the
  32. current subdirectory branch that match a given filespec, and their locations.
  33.  
  34. BDIR will search the current directory and all its subdirectories for files
  35. matching the file specification entered on the command line, including 
  36. wildcards, and list them in directory format, including the path to each file.
  37. It also gives the total count of these files, and their total size.
  38. Executing BDIR from the root directory will search the entire disk.
  39. In contrast to DOS' DIR command with a /S parameter, BDIR provides a concise,
  40. easily-read format.
  41.  
  42. Example                                                      Command
  43. -------                                                      -------
  44. "I know the program's name is CHESS, but not where it is."   bdir chess*.*
  45. "What EXE files are available in this application?"          bdir *.exe
  46. "How much disk space am I taking up on GIF files?"           bdir *.gif
  47. "Which subdirectory has the latest copy of my resume?"       bdir resume*.*
  48. "What subdirectories does this subdirectory contain?"        bdir .
  49.  
  50. -----------------------------------------------------------------------------
  51.  
  52. BDEL.COM ("Branch DELete") prompts for deletion of files within the current
  53. subdirectory branch that match the given filespec.
  54.  
  55. BDEL will search the current directory and all its subdirectories for files
  56. matching the given filespec (including wildcards), display full information
  57. on the file including its path, and prompt the user with "Delete (Y/N/A/Q)?".
  58. Responding "Y" will delete the file, "N" will skip it, "A" will switch to
  59. "auto mode" (also selectable via a switch, /a) in which all remaining
  60. matching files are automatically deleted, and "Q" will quit back to the DOS
  61. prompt.
  62.  
  63. Example                                                      Command
  64. -------                                                      -------
  65. "Selectively delete some of these DOC files."                bdel *.doc
  66. "Delete all the BAK files, don't prompt."                    bdel *.bak /a
  67.  
  68. -----------------------------------------------------------------------------
  69.  
  70. GD.COM ("Go to Directory") searches for, and changes to, a subdirectory
  71. matching the given filespec.
  72.  
  73. GD allows the user to bypass typing (or remembering) the full pathname to
  74. the desired directory for DOS' CD.  GD also allows abbreviating the
  75. subdirectory's name using the "*" wildcard.  GD is fast, even faster with
  76. Microsoft's SMARTDRV installed.
  77.  
  78. Example                                                      Command
  79. -------                                                      -------
  80. cd \multimed\sound\music\classicl\vivaldi                    gd viv*
  81.  
  82. -----------------------------------------------------------------------------
  83.  
  84. KD.COM ("Kill Directory") removes an entire specified subdirectory branch
  85. from the directory tree.  It will remove all the sub-subdirectories and
  86. files of that specified subdirectory.
  87.  
  88. As a DOS command-line utility, it can be more convenient than application
  89. programs with similar capabilities.  To remove a subdirectory, simply type
  90. "kd" followed by the subdirectory name.  The program will display the path
  91. of each subdirectory/file being removed, and end with a count of the
  92. number of each, along with a count of the total bytes removed.  Unlike the
  93. DELTREE of DOS 6+, KD offers full reporting and verification of the request
  94. to remove the branch.
  95.  
  96. Example                                                      Command
  97. -------                                                      -------
  98. "Remove the whole subdirectory DATA, in this directory."     kd data
  99. "Remove the directory I'm in now."                           kd .
  100. "Remove the application OLDAPP, in my D: drive."             kd d:\oldapp
  101.  
  102. -----------------------------------------------------------------------------
  103.  
  104. XD.COM ("eXpand to Directory") creates like-named directories for files
  105. matching the given filespec, and transfers the files to them.
  106.  
  107. XD will create a subdirectory (the new subdirectory name being the same as
  108. the filename without an extension) for each file in the current directory
  109. that matches the filespec, and move these files to the appropriate created
  110. subdirectory (if there are several files that vary only by extension, they
  111. will be placed in the same subdirectory).  If only one file is expanded, XD
  112. will automatically change to its subdirectory.
  113.  
  114. Although the primary use for XD is quick manipulation of archive files, it
  115. can be convenient whenever the user would like to begin a category of files
  116. based one (or more) files.
  117.  
  118. Example                                                      Command
  119. -------                                                      -------
  120. "Place all the ZIP files in their own subdirectories."       xd *.zip
  121. "Put WIDGET.DOC, WIDGET.EXE, and WIDGET.CFG in a subdir."    xd widget.*
  122.  
  123. -----------------------------------------------------------------------------
  124.  
  125. MP.COM ("Make Path") creates a nested set of directories.
  126.  
  127. MP creates a nested set of directories with a single command.  Using the /C
  128. switch will change to the last directory that was created.  If an error occurs
  129. during the MP process, its progress will be retained.  If the entire path or
  130. part of the path exists, no error will be reported.  A trailing "\" is
  131. allowed, though not required.
  132.  
  133. Example                                                 Command  
  134. -------                                                 -------
  135. "Make a new directory OLDDATA within a new directory    MP BACKUP\OLDDATA
  136. BACKUP."
  137. "I need to create the directory C:\WORD\DATA\MYDATA   
  138. even though C:\WORD does not exist."                    MP C:\WORD\DATA\MYDATA
  139.  
  140. -----------------------------------------------------------------------------
  141.  
  142. CLEAR.COM irreversibly erases the contents of files and deletes them.
  143.  
  144. CLEAR erases the contents of the specified files (DOS wildcards accepted)
  145. and deletes them.  With the /A switch, a more thorough, three-pass clearing
  146. process will be used.  The confirmation prompt will appear only once for all
  147. of the selected files.  Warning:  CLEAR was designed to permanently erase
  148. files and it will do exactly that.  While recovery of CLEARed files may be 
  149. possible with specialized hardware that is not readily available to the
  150. public, you can feel safe your sensitive data is unrecoverable by any
  151. practical means.
  152.  
  153. Example                                                    Command  
  154. -------                                                    -------
  155. "Destroy the BUDGET.WKS spreadsheet."                      clear budget.wks
  156. "Destroy all the files in the C:\SECRET directory."        clear c:\secret\*.*
  157.  
  158. -----------------------------------------------------------------------------
  159.  
  160. SIZE gives an overview of the disk space consumed on a directory-branch-by-
  161. directory-branch basis.  It calculates the total byte count and disk
  162. clusters consumed by all the subdirectories and files within each directory
  163. of the specified directory, and outputs this data (including percentages)
  164. in a concise format.
  165.  
  166. Example                                                    Command
  167. -------                                                    -------
  168. "What directories are consuming the most disk space?"      size c:
  169. "How much space are each of these subdirectories taking?"  size miscapps
  170.  
  171. -----------------------------------------------------------------------------
  172.  
  173. INCDOS programs and documentation are copyright (C) 1993-1995
  174. Virtuosi Development, Inc.
  175.  
  176. Permission given to distribute freely in intact form.
  177.  
  178. As is; all warranty/liability disclaimed (there are a great number of 
  179. possible combinations of hardware/DOS-versions/caches/disk-doublers/BIOSes/
  180. network-software; although we are trying to make INCDOS fully compatible
  181. with everything, we can't guarantee it).
  182.  
  183. Please send any correspondence to--
  184.  
  185. Electronic mail:  virtuosi@ic.net (Internet)
  186.  
  187. Mechanical mail:  Virtuosi Development, Inc.
  188.                   615 Hidden Valley Drive
  189.                   Suite 114
  190.                   Ann Arbor, MI  48104-6747
  191.  
  192. If you find INCDOS useful, we request that you register it by sending
  193. US$25 (plus US$5 for shipping on orders outside the United States) to the
  194. above address.  Please make your check or money order payable to Virtuosi
  195. Development, and include your current mailing address.
  196.  
  197. After payment is received, we will send you a disk containing the registered 
  198. set of the INCDOS utilities, including a full set optimized for 32-bit
  199. processors.
  200.  
  201. Thanks for your consideration; your registration makes possible the continued
  202. distribution of INCDOS as shareware.
  203.